markdown-utils

markdown-utils

Create markdown snippets.

Install with npm

npm i markdown-utils --save

Run tests

npm test

Usage

var mdu = require('markdown-utils');

API

.anchor

Create a markdown-formatted anchor link from the given values.

• anchor {String}
• href {String}
• title {String}

utils.anchor('embed', 'assemble/handlebars-helpers/lib/code.js', 25, 'v0.6.0');
//=> [embed](https://github.com/assemble/handlebars-helpers/blob/v0.6.0/lib/helpers/code.js#L25)

.badge

Create a markdown-formatted badge.

• alt {String}
• img_url {String}
• url {String}

utils.badge(alt, img_url, url);
//=> [![Build Status](https://travis-ci.org/jonschlinkert/template.svg)](https://travis-ci.org/jonschlinkert/template)

.blockquote

Create a markdown-formatted blockquote.

• str {String}

utils.blockquote('This is a blockquote');
//=> '> This is a blockquote'

.code

Create a markdown-formatted <code></code> snippet.

• str {String}

utils.code('var foo = bar;');
//=> '`var foo = bar;`'

.del

Create markdown-formatted <del></del>.

• str {String}

utils.del('text');
//=> '~~text~~'

.em

Create a markdown-formatted em.

• str {String}

utils.em('This is emphasized');
//=> '_This is emphasized_'

.h1

Create a markdown-formatted h1 heading.

• str {String}

utils.h1('This is a heading');
//=> '# This is a heading'

.h2

Create a markdown-formatted h2 heading.

• str {String}

utils.h2('This is a heading');
//=> '## This is a heading'

.h3

Create a markdown-formatted h3 heading.

• str {String}

utils.h3('This is a heading');
//=> '### This is a heading'

.h4

Create a markdown-formatted h4 heading.

• str {String}

utils.h4('This is a heading');
//=> '#### This is a heading'

.h5

Create a markdown-formatted h5 heading.

• str {String}

utils.h5('This is a heading');
//=> '##### This is a heading'

.h6

Create a markdown-formatted h6 heading.

• str {String}

utils.h6('This is a heading');
//=> '###### This is a heading'

.heading

Create a markdown-formatted heading.

• str {String}
• level {Number}

utils.heading('This is a heading', 1);
//=> '# This is a heading'

.hr

Create a markdown-formatted horizontal rule.

• str {String}: Alternate string to use. Default is *** to avoid collision with --- which is used for front matter.

utils.hr();
//=> '***'

.image

Create a markdown-formatted image from the given values.

• alt {String}
• src {String}
• title {String}

utils.image(alt, src);
//=> ![Build Status](https://travis-ci.org/jonschlinkert/template.svg)

utils.image(alt, src, title);
//=> ![Build Status](https://travis-ci.org/jonschlinkert/template.svg "This is title of image!")

.link

Create a markdown-formatted link from the given values.

• anchor {String}
• href {String}
• title {String}

utils.link('fs-utils', 'https://github.com/assemble/fs-utils', 'hover title');
//=> [fs-utils](https://github.com/assemble/fs-utils "hover title")

.listitem

Create a markdown-formatted listitem.

• str {String}
• level {Number}
• options {String}

utils.item('Level 0 list item', 0);
//=> '* Level 0 list item'

utils.item('Level 1 list item', 1);
//=> '  * Level 1 list item'

utils.item('Level 2 list item', 2);
//=> '    * Level 2 list item'

.pre

Create a markdown-formatted <pre><code></code></pre> snippet with or without lang.

• str {String}
• language {String}

utils.pre('var foo = bar;');

Results in:

```js
var foo = bar;
```

.reference

Create a markdown-formatted reference link from the given values.

• id {String}
• url {String}
• title {String}

utils.reference('template', 'https://github/jonschlinkert/template', 'Make stuff!');
//=> [template]: https://github/jonschlinkert/template "Make stuff!"

.strong

Create markdown-formatted bold text.

• str {String}

utils.strong('This is bold');
//=> '**This is bold**'

.todo

Create a markdown-formatted todo item.

• str {String}

utils.todo('this is a todo.');
//=> '- [ ] this is a todo'

utils.todo('this is a completed todo.', true);
//=> '- [x] this is a todo'

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert
Released under the MIT license

---

This file was generated by verb on December 21, 2014.